Collecting a list of inbound fax and sms messages Schema
api_request Element
Description
Starts a connection request.
Namespace (none)
Diagram
to_date Element from_date Element password Element username Element action Element Sequence api_request Element
Overview
api_request
Starts a connection request.
Sequence
action xs:string

One of 9 action types. This lets us know the type of connection you wish to make and what you need the API to do for you.  In the case of Collecting a list of inbound messages the action type is "list".

username xs:string
The username of this user as stored on the PRODOCOM system. You will need to get this information from PRODOCOM before you attempt any form of API connection.  Typically the username is your PRODOCOM website login.
password xs:string
The password of this user as stored on the PRODOCOM system.  You will need to get this information from PRODOCOM before you attempt any form of API connection.
from_date xs:string

The start date and time to look for jobs to be reported.  Times and dates are always in GMT and yyyy-mm-dd hh:mm:ss. If you are only concerned about the date and not the time, simply use 00:00:00 for the time.

to_date xs:string
The end date and time to look for jobs to be reported. Times and dates are always in GMT and yyyy-mm-dd hh:mm:ss. If you are only concerned about the date and not the time, simply use 00:00:00 for the time.
Source
<xs:element name="api_request" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType>
    <xs:sequence>
      <xs:element type="xs:string" name="action" />
      <xs:element type="xs:string" name="username" />
      <xs:element type="xs:string" name="password" />
      <xs:element type="xs:string" name="from_date" />
      <xs:element type="xs:string" name="to_date" />
    </xs:sequence>
  </xs:complexType>
</xs:element>
See Also
Collecting a list of inbound fax and sms messages SchemaCollecting a list of inbound fax and sms messages result Schema

 

 


© 2013 All Rights Reserved.

Send comments on this topic.